<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkToggleToolButton</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="prev" href="GtkMenuToolButton.html" title="GtkMenuToolButton">
<link rel="next" href="GtkRadioToolButton.html" title="GtkRadioToolButton">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="Builder.html" title="Interface builder">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="chapter" href="gtk-migrating-GtkBuilder.html" title="Migrating from libglade to GtkBuilder">
<link rel="chapter" href="gtk-migrating-tooltips.html" title="Migrating from GtkTooltips to GtkTooltip">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="api-index-full.html" title="Index of all symbols">
<link rel="index" href="api-index-deprecated.html" title="Index of deprecated symbols">
<link rel="index" href="api-index-2-2.html" title="Index of new symbols in 2.2">
<link rel="index" href="api-index-2-4.html" title="Index of new symbols in 2.4">
<link rel="index" href="api-index-2-6.html" title="Index of new symbols in 2.6">
<link rel="index" href="api-index-2-8.html" title="Index of new symbols in 2.8">
<link rel="index" href="api-index-2-10.html" title="Index of new symbols in 2.10">
<link rel="index" href="api-index-2-12.html" title="Index of new symbols in 2.12">
<link rel="index" href="api-index-2-14.html" title="Index of new symbols in 2.14">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkMenuToolButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="MenusAndCombos.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="GtkRadioToolButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkToggleToolButton.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#GtkToggleToolButton.description" class="shortcut">Description</a>
                 | 
                <a href="#GtkToggleToolButton.object-hierarchy" class="shortcut">Object Hierarchy</a>
                 | 
                <a href="#GtkToggleToolButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                 | 
                <a href="#GtkToggleToolButton.properties" class="shortcut">Properties</a>
                 | 
                <a href="#GtkToggleToolButton.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkToggleToolButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkToggleToolButton.top_of_page"></a>GtkToggleToolButton</span></h2>
<p>GtkToggleToolButton — A GtkToolItem containing a toggle button</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkToggleToolButton.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;gtk/gtk.h&gt;

                    <a class="link" href="GtkToggleToolButton.html#GtkToggleToolButton-struct" title="GtkToggleToolButton">GtkToggleToolButton</a>;
<a class="link" href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a> *       <a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-new" title="gtk_toggle_tool_button_new ()">gtk_toggle_tool_button_new</a>          (void);
<a class="link" href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a> *       <a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-new-from-stock" title="gtk_toggle_tool_button_new_from_stock ()">gtk_toggle_tool_button_new_from_stock</a>
                                                        (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);
void                <a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-set-active" title="gtk_toggle_tool_button_set_active ()">gtk_toggle_tool_button_set_active</a>   (<a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *button,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_active);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-get-active" title="gtk_toggle_tool_button_get_active ()">gtk_toggle_tool_button_get_active</a>   (<a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *button);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
                     +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
                           +----<a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
                                 +----<a class="link" href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>
                                       +----<a class="link" href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a>
                                             +----GtkToggleToolButton
                                                   +----<a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton">GtkRadioToolButton</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkToggleToolButton implements
 AtkImplementorIface and  <a class="link" href="gtk-gtkbuildable.html#GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GtkToggleToolButton.html#GtkToggleToolButton--active" title='The "active" property'>active</a>"                   <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>              : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GtkToggleToolButton.html#GtkToggleToolButton-toggled" title='The "toggled" signal'>toggled</a>"                                        : Run First
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.description"></a><h2>Description</h2>
<p>
  A <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> is a <a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> that contains a toggle
  button.
</p>
<p>
  Use <a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-new" title="gtk_toggle_tool_button_new ()"><code class="function">gtk_toggle_tool_button_new()</code></a> to create a new
  <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>. Use <a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-new-from-stock" title="gtk_toggle_tool_button_new_from_stock ()"><code class="function">gtk_toggle_tool_button_new_from_stock()</code></a> to
  create a new <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> containing a stock item.
</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GtkToggleToolButton-struct"></a><h3>GtkToggleToolButton</h3>
<pre class="programlisting">typedef struct _GtkToggleToolButton GtkToggleToolButton;</pre>
<p>
  The <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> struct contains only private data and
  should only be accessed through the functions described below.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-tool-button-new"></a><h3>gtk_toggle_tool_button_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a> *       gtk_toggle_tool_button_new          (void);</pre>
<p>
Returns a new <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>

</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-tool-button-new-from-stock"></a><h3>gtk_toggle_tool_button_new_from_stock ()</h3>
<pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a> *       gtk_toggle_tool_button_new_from_stock
                                                        (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);</pre>
<p>
Creates a new <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> containing the image and text from a
stock item. Some stock ids have preprocessor macros like <a class="link" href="gtk-Stock-Items.html#GTK-STOCK-OK--CAPS" title="GTK_STOCK_OK"><span class="type">GTK_STOCK_OK</span></a>
and <a class="link" href="gtk-Stock-Items.html#GTK-STOCK-APPLY--CAPS" title="GTK_STOCK_APPLY"><span class="type">GTK_STOCK_APPLY</span></a>.
</p>
<p>
It is an error if <em class="parameter"><code>stock_id</code></em> is not a name of a stock item.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td>
<td> the name of the stock item 
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-tool-button-set-active"></a><h3>gtk_toggle_tool_button_set_active ()</h3>
<pre class="programlisting">void                gtk_toggle_tool_button_set_active   (<a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *button,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_active);</pre>
<p>
Sets the status of the toggle tool button. Set to <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a> if you
want the GtkToggleButton to be 'pressed in', and <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
><code class="literal">FALSE</code></a> to raise it.
This action causes the toggled signal to be emitted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
<td> a <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_active</code></em> :</span></p></td>
<td> whether <em class="parameter"><code>button</code></em> should be active
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-toggle-tool-button-get-active"></a><h3>gtk_toggle_tool_button_get_active ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            gtk_toggle_tool_button_get_active   (<a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *button);</pre>
<p>
Queries a <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> and returns its current state.
Returns <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a> if the toggle button is pressed in and <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
><code class="literal">FALSE</code></a> if it is raised.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td>
<td> a <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a> if the toggle tool button is pressed in, <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
><code class="literal">FALSE</code></a> if not

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.4</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GtkToggleToolButton--active"></a><h3>The <code class="literal">"active"</code> property</h3>
<pre class="programlisting">  "active"                   <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>              : Read / Write</pre>
<p>
If the toggle tool button should be pressed in or not.</p>
<p>
</p>
<p>Default value: FALSE</p>
<p>Since 2.8</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="GtkToggleToolButton-toggled"></a><h3>The <code class="literal">"toggled"</code> signal</h3>
<pre class="programlisting">void                user_function                      (<a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *toggle_tool_button,
                                                        <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a>             user_data)               : Run First</pre>
<p>
Emitted whenever the toggle tool button changes state.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>toggle_tool_button</code></em> :</span></p></td>
<td> the object that emitted the signal
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GtkToggleToolButton.see-also"></a><h2>See Also</h2>
<p>
  <dt>
<span class="term"><a class="link" href="GtkToolbar.html" title="GtkToolbar"><span class="type">GtkToolbar</span></a>, </span><span class="term"><a class="link" href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>, </span><span class="term"><a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a></span>
</dt><dd>
<p>The toolbar widget</p>
<p>
	The parent class of <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>. The properties
	"label_widget", "label", "icon_widget", and "stock_id" on
	<a class="link" href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> determine the label and icon used on
	<a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>s.
      </p>
<p>A subclass of <a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> that separates groups of
	items on a toolbar.
      </p>
</dd>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>
